/* -*- mode: c++; c-basic-offset: 4; indent-tabs-mode: nil; -*-
 *  vim:expandtab:shiftwidth=4:tabstop=4:smarttab:
 *
 *  Copyright (c) 2010, 2024, Oracle and/or its affiliates.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, version 2.0,
 *  as published by the Free Software Foundation.
 *
 *  This program is designed to work with certain software (including
 *  but not limited to OpenSSL) that is licensed under separate terms,
 *  as designated in a particular file or component or in included license
 *  documentation.  The authors of MySQL hereby grant you an additional
 *  permission to link the program and your derivative works with the
 *  separately licensed software that they have either included with
 *  the program or referenced in the documentation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License, version 2.0, for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 */

#ifndef Driver_hpp
#define Driver_hpp

#include <fstream>
#include <iostream>
#include <sstream>
#include <string>
#include <vector>

#include <sys/time.h>

#include "Properties.hpp"

using std::ofstream;
using std::ostringstream;
using std::string;
using std::vector;

using utils::Properties;

class Driver {
 public:
  /**
   * Parses the benchmark's command-line arguments.
   */
  static void parseArguments(int argc, const char *argv[]);

  /**
   * Creates an instance.
   */
  Driver() {}

  /**
   * Deletes an instance.
   */
  virtual ~Driver() {}

  /**
   * Runs the benchmark.
   */
  void run();

 protected:
  // command-line arguments
  static vector<string> propFileNames;
  static string logFileName;

  static void exitUsage();

  // driver settings
  Properties props;
  int warmupRuns;

  // driver resources
  ofstream log;
  string descr;
  bool logHeader;
  ostringstream header;
  ostringstream rtimes;
  struct timeval t0, t1;
  long rta;

  // driver initializers/finalizers
  virtual void init();
  virtual void close();
  virtual void loadProperties();
  virtual void initProperties();
  virtual void printProperties();
  virtual void openLogFile();
  virtual void closeLogFile();

  // benchmark operations
  virtual void runTests() = 0;
  virtual void clearLogBuffers();
  virtual void writeLogBuffers();
  virtual void begin(const string &name);
  virtual void finish(const string &name);
};

#endif  // Driver_hpp
